home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 May / macformat-024.iso / Shareware City / Science / Rootlocs v.1.0 Folder / Readme < prev    next >
Encoding:
Text File  |  1995-01-19  |  7.7 KB  |  143 lines  |  [TEXT/ttxt]

  1.                                        Readme file for ROOTLOCS v 1.0 
  2.                                         
  3. Program Description
  4. ------------------
  5. ROOTLOCS is a program for plotting  Root Locus diagrams of linear control systems.  Given the positions of the open loop poles and zeros of a system in the complex plane, it plots the loci of the system's closed loop poles as the loop gain of the system is increased indefinitely starting from zero.  ROOTLOCS can handle systems with up to 18 poles and 18 zeros,  it offers a choice of working in either the S or the Z plane 
  6. and it allows investigation of both positive and negative gain control loops.  
  7.    
  8.  
  9. System Requirements 
  10. -------------------
  11. ROOTLOCS  requires system 7  and a screen resolution of at least 640 x 480 pixels (preferably colour). 
  12.  
  13. The program was written and tested on a Macintosh Power Book 540c but it should
  14. run on any Mac meeting the above basic requirements.  The present version has no automatic detection of screen size so the plot may appear somewhat small on large monitors - I hope to fix that in a future version.  Colour capability of at least 4 colours is desirable but not absolutely essential: the program will run on non-colour 
  15. systems but the 'Show Points'  tool in the "Tools" menu may not work entirely as it should.  On slower machines (68030  and less), the plotting time for systems with many poles and  zeros may be rather long. 
  16.  
  17.  
  18. Data Input Procedure
  19. -------------------
  20. On starting the program a window called  "Root Locus Inputs"  appears.  This window  contains a number of editable data fields and buttons into which the following data
  21. has to be entered at the appropriate places :    
  22.  
  23.         *  number of open loop poles and zeros in the system to be plotted  
  24.  
  25.             *  the open loop pole and zero positions  (real and imaginary parts)
  26.  
  27.         *  the left, right, lower and upper boundaries of the plotting region
  28.             where the loci are expected to appear
  29.  
  30.         *  the working plane of interest,  S or Z           -      (radio button)
  31.  
  32.         *  positive or negative gain loci required         -      (radio button)
  33.  
  34.  
  35. IMPORTANT  -  PLEASE READ CAREFULLY
  36. The Data Insertion Prompt (DIP) takes the form of a flashing vertical bar. On program
  37. start the DIP is positioned at the left of the first data entry field  (number of poles). 
  38. After entering data into any field, the DIP should be advanced to the next field with 
  39. the TAB key,  or,  it may be moved backwards (e.g. for editing) with SHIFT+TAB.  The
  40. DIP can also be positioned by pointing and clicking with the mouse.  The CReturn key
  41. is NOT used during data entry mode.  The left, right, lower and upper boundaries of 
  42. the plotting region must be entered into the (non-outlined) fields located at the two lower and two right corners of the mini-plane near the bottom of the Input Window. When data entry is complete,  root locus plotting can be started by clicking on the START button or pressing the CReturn key.  
  43.  
  44. The use of the TAB key to advance the DIP takes a little getting used to. I advise to keep one finger permanently on the TAB key during data entry.  It will be found that, 
  45. once mastered, this technique allows data to be entered quickly and effectively. 
  46.  
  47. The Input Window also contains a button called TEST.  This button calls up a built-
  48. in set of PZ values and draws a simple Root Locus plot. The purpose is to  perform 
  49. a quick check and demonstration of program operation without having to enter any data at all.  I recommend to try this button first.    
  50.  
  51.  
  52. A word about the Plots  
  53. --------------------
  54. All loci that terminate inside the plotting region, as well as those that cross it, are
  55. plotted. The plotting time increases rapidly with the number of  PZ  and ranges from
  56. a few seconds for the simplest systems up to about 10  minutes (on a PB 540c) for a system with the full 18 pole and 18 zero complement.  
  57.  
  58. Systems with non-conjugate P and/or Z  (corresponding to polynomials with complex coefficients)  are plotted as readily as normal (fully conjugate) systems.
  59.  
  60. The coordinates of the open loop PZ,  and the coordinates and gains of points clicked onto the Root Loci with the SHOW GAIN POINTS tool (see below), are displayed in the upper and lower windows, respectively, to the right of the main Root Locus plot.
  61.  
  62. The plotting process can be interrupted by pressing  CMD + Period.   
  63.  
  64.  
  65. Tools
  66. -----
  67. After all loci have been plotted, a number of tools are available from the Tools menu:
  68.  
  69.         * SHOW DAMPING LINES - shows lines of constant damping ratio  
  70.            in the S plane, or lines of constant damping ratio and constant
  71.            undamped natural frequency in the Z plane
  72.  
  73.         * SHOW GAIN POINTS - enables the root locus gain and coordinates 
  74.            of points on the plotted loci to be interrogated with the mouse
  75.  
  76.         * WIPE LINES & POINTS - removes the damping lines and  gain points 
  77.            drawn with the two previous tools 
  78.  
  79.         * SET GAIN MARKER - sets a marker at a user defined gain value on
  80.            all locus branches
  81.  
  82.         * EDIT INPUTS - brings up the data input window and allows the   
  83.            inputs to be modified for a new plot .
  84.  
  85.  
  86. Limitations
  87. -----------
  88. The program has been extensively tested and incorporates special routines to cope with 'difficult'  PZ patterns.  It is, therefore, reasonably robust and can be relied upon to handle most situations successfully.  Nevertheless, it is not possible to guarantee that all PZ arrangements will be handled without problem and situations may arise which cause the computer to 'hang'. 
  89.  
  90. In order to minimise the probability of 'hang-up', the following specific situations should be avoided as far as possible: 
  91.  
  92.      -  Coincident singularities of different type.
  93.          ------------------------------------- 
  94.          Coincident poles are  o.k. and coincident zeros are  o.k. but poles coincident
  95.          with zeros (cancellation) should not be input
  96.  
  97.      -  Closely spaced singularities
  98.          ------------------------- 
  99.          PZ spacings which are very small compared with the plotting region size
  100.          (diagonal) may give rise to problems. In the event of hang-up in such cases, 
  101.          try reducing the size of the plotting region or force coincidence of closely
  102.          spaced  PZ of the same type (i.e. approximate them with multiple order
  103.          poles or multiple order zeros) 
  104.  
  105.      -  Singularities on Boundaries of Plane
  106.          --------------------------------
  107.          The boundaries of the plotting region should  be chosen so they do not have 
  108.          any open loop poles or zeros on them 
  109.  
  110. Should any 'problem cases' be found which can not be explained by any of the above conditions, I would appreciate to receive details of them.  Such feedback will help me to refine the program further. 
  111.  
  112.  
  113. Disclaimer  and Legal Stuff
  114. -------------------------
  115. ROOTLOCS is freeware.  It is supplied  ‘as is’  and its suitability for any particular purpose is not guaranteed. I cannot be held responsible for any loss or damage  arising out of the use or misuse of the program.
  116.  
  117. No part of this software may be redistributed in modified form, and no part may be removed and used as part of any other software without the express permission of  
  118. the author in writing.  This document in unmodified form must accompany any copies
  119. of the software that may be made. 
  120.  
  121.  
  122.  
  123. Literature References
  124. --------------------
  125. Graphical Analysis of Control Systems.  
  126. W.R. Evans,  Trans. AIEE  vol. 67  pp. 547-551, 1948 
  127.  
  128. Numerical Computation of Root Loci Using the Newton-Raphson Technique. 
  129. R.H.Ash & G.H.Ash,  IEEE Transactions on Automatic Control,   October 1968.
  130.   
  131.  
  132.  
  133.  
  134. Alan Robinson
  135. Lange Kerkdam 33A
  136. 2242 BP Wassenaar
  137. The Netherlands
  138. Tel: 01751-10431
  139. email: A.Robinson@inter.NL.net
  140.  
  141.  
  142.  
  143.